home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cat3 / SCFeederGetFlags.z / SCFeederGetFlags
Text File  |  1998-10-30  |  8KB  |  199 lines
  1.  
  2.  
  3.  
  4. SSSSCCCCFFFFeeeeeeeeddddeeeerrrrGGGGeeeettttFFFFllllaaaaggggssss((((3333))))              IIIImmmmpppprrrreeeessssssssaaaarrrriiiioooo               SSSSCCCCFFFFeeeeeeeeddddeeeerrrrGGGGeeeettttFFFFllllaaaaggggssss((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SCFeederGetFlags, SCFeederSetFlags, SCFeederAdvance, SCFeederReady -
  10.      scanner document feeder functions
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      ####iiiinnnncccclllluuuuddddeeee <<<<ssssttttddddiiiioooo....hhhh>>>>
  14.      ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccaaaannnnnnnneeeerrrr....hhhh>>>>
  15.  
  16.      iiiinnnntttt SSSSCCCCFFFFeeeeeeeeddddeeeerrrrGGGGeeeettttFFFFllllaaaaggggssss((((SSSSCCCCAAAANNNNNNNNEEEERRRR ****ssss,,,, SSSSCCCCFFFFEEEEEEEEDDDDEEEERRRRFFFFLLLLAAAAGGGGSSSS ****ffffllllaaaaggggssss))));;;;
  17.  
  18.      iiiinnnntttt SSSSCCCCFFFFeeeeeeeeddddeeeerrrrSSSSeeeettttFFFFllllaaaaggggssss((((SSSSCCCCAAAANNNNNNNNEEEERRRR ****ssss,,,, SSSSCCCCFFFFEEEEEEEEDDDDEEEERRRRFFFFLLLLAAAAGGGGSSSS ffffllllaaaaggggssss))));;;;
  19.  
  20.      iiiinnnntttt SSSSCCCCFFFFeeeeeeeeddddeeeerrrrAAAAddddvvvvaaaannnncccceeee((((SSSSCCCCAAAANNNNNNNNEEEERRRR ****ssss))));;;;
  21.  
  22.      iiiinnnntttt SSSSCCCCFFFFeeeeeeeeddddeeeerrrrRRRReeeeaaaaddddyyyy((((SSSSCCCCAAAANNNNNNNNEEEERRRR ****ssss))));;;;
  23.  
  24. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  25.      _S_C_F_e_e_d_e_r_G_e_t_F_l_a_g_s gets _f_l_a_g_s that describe a scanner's document feeding
  26.      capabilities.  _s specifies a connection to a scanner driver obtained by a
  27.      call to _S_C_O_p_e_n(3), _S_C_O_p_e_n_F_i_l_e(3), or _S_C_O_p_e_n_S_c_r_e_e_n(3).
  28.  
  29.      SSSSCCCCFFFFEEEEEEEEDDDDEEEERRRRFFFFLLLLAAAAGGGGSSSS and the values it can take on are defined in <_s_c_a_n_n_e_r._h> as
  30.      follows:
  31.  
  32.           typedef unsigned int SCFEEDERFLAGS;
  33.  
  34.           #define SC_HASFEEDER 1
  35.           #define SC_AUTOFEED  2
  36.           #define SC_PROGFEED  4
  37.  
  38.  
  39.      The meanings of the flags are as follows:
  40.  
  41.      SSSSCCCC____HHHHAAAASSSSFFFFEEEEEEEEDDDDEEEERRRR: this flag is set if there is a document feeder attached to
  42.      the scanner.
  43.  
  44.      SSSSCCCC____AAAAUUUUTTTTOOOOFFFFEEEEEEEEDDDD: this flag is set if the feeder can operate such that each
  45.      call to _S_C_S_c_a_n(3) causes the next document to be loaded.
  46.  
  47.      SSSSCCCC____PPPPRRRROOOOGGGGFFFFEEEEEEEEDDDD: this flag is set if the feeder can operate such that
  48.      _S_C_S_c_a_n(3) can be called multiple times per document, with a call to
  49.      _S_C_F_e_e_d_e_r_A_d_v_a_n_c_e being necessary to load the next document.
  50.  
  51.      _S_C_F_e_e_d_e_r_S_e_t_F_l_a_g_s should be called before calling _S_C_S_c_a_n(3) for scanners
  52.      for which _S_C_F_e_e_d_e_r_G_e_t_F_l_a_g_s yields both SSSSCCCC____AAAAUUUUTTTTOOOOFFFFEEEEEEEEDDDD and SSSSCCCC____PPPPRRRROOOOGGGGFFFFEEEEEEEEDDDD set.
  53.  
  54.      After calling
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSCCCCFFFFeeeeeeeeddddeeeerrrrGGGGeeeettttFFFFllllaaaaggggssss((((3333))))              IIIImmmmpppprrrreeeessssssssaaaarrrriiiioooo               SSSSCCCCFFFFeeeeeeeeddddeeeerrrrGGGGeeeettttFFFFllllaaaaggggssss((((3333))))
  71.  
  72.  
  73.  
  74.           SCFeederSetFlags(s, SC_AUTOFEED);
  75.  
  76.  
  77.      the feeder will advance to the next document after every call to SCScan.
  78.      After calling
  79.  
  80.           SCFeederSetFlags(s, SC_PROGFEED);
  81.  
  82.  
  83.      a call to _S_C_F_e_e_d_e_r_A_d_v_a_n_c_e after each scan is necessary to advance to the
  84.      next document.
  85.  
  86.      _S_C_F_e_e_d_e_r_A_d_v_a_n_c_e advances the feeder to the next document.  This call is
  87.      only valid if the scanner supports SSSSCCCC____PPPPRRRROOOOGGGGFFFFEEEEEEEEDDDD mode.  In addition, for
  88.      scanners that support both SSSSCCCC____AAAAUUUUTTTTOOOOFFFFEEEEEEEEDDDD and SSSSCCCC____PPPPRRRROOOOGGGGFFFFEEEEEEEEDDDD mode,
  89.  
  90.           SCFeederSetFlags(s, SC_PROGFEED);
  91.  
  92.  
  93.      must have been called previously.
  94.  
  95.      Use _S_C_F_e_e_d_e_r_R_e_a_d_y to check if the feeder is ready for feeding.
  96.  
  97. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  98.      _S_C_F_e_e_d_e_r_G_e_t_F_l_a_g_s, _S_C_F_e_e_d_e_r_S_e_t_F_l_a_g_s, and _S_C_F_e_e_d_e_r_A_d_v_a_n_c_e return 0 if
  99.      successful or -1 if an error occurs.
  100.  
  101.      _S_C_F_e_e_d_e_r_R_e_a_d_y returns 0 if the feeder is ready, and -1 with _S_C_e_r_r_n_o set
  102.      to SSSSCCCCFFFFEEEEEEEEDDDDEEEERRRREEEEMMMMPPPPTTTTYYYY if the feeder is not ready.  If any other error
  103.      conditions exist, _S_C_e_r_r_n_o will be set appropriately.
  104.  
  105. EEEEXXXXEEEECCCCUUUUTTTTIIIIOOOONNNN EEEERRRRRRRROOOORRRR CCCCOOOODDDDEEEESSSS
  106.      These functions can all fail due to a communications error with the
  107.      scanner driver, in which case _S_C_e_r_r_n_o will be set as follows.
  108.  
  109.      SCECOMM                  Error communicating with scanner driver
  110.  
  111.      Additionally, _S_C_F_e_e_d_e_r_S_e_t_F_l_a_g_s, _S_C_F_e_e_d_e_r_A_d_v_a_n_c_e, and _S_C_F_e_e_d_e_r_R_e_a_d_y will
  112.      fail under the following circumstances.  circumstances.
  113.  
  114.      SCENOFEEDER              No feeder
  115.  
  116.      SCEAUTOONLY              Feeder only supports automatic usage
  117.  
  118.      SCEFEEDEREMPTY           Feeder empty
  119.  
  120.      SCEFEEDERJAMMED          Feeder jammed
  121.  
  122.      SCEFEEDERERR             Feeder error
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSCCCCFFFFeeeeeeeeddddeeeerrrrGGGGeeeettttFFFFllllaaaaggggssss((((3333))))              IIIImmmmpppprrrreeeessssssssaaaarrrriiiioooo               SSSSCCCCFFFFeeeeeeeeddddeeeerrrrGGGGeeeettttFFFFllllaaaaggggssss((((3333))))
  137.  
  138.  
  139.  
  140. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  141.      _l_i_b_s_c_a_n(3), _S_C_O_p_e_n(3), _S_C_S_c_a_n(3), _S_C_S_c_a_n_F_D(3).
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.